home *** CD-ROM | disk | FTP | other *** search
/ Amiga Aktuell / Amiga Aktuell.iso / c / embedderii.doc < prev    next >
Text File  |  1996-09-05  |  11KB  |  234 lines
  1.  
  2.                                  Embedder II
  3.                                 Release V1.0
  4.                 (C) Copyright 1993,1994 Bigmama/Focus Design
  5.                             All Rights Reserved
  6.  
  7.  
  8.                                Copyright note
  9.                                ~~~~~~~~~~~~~~
  10.   Embedder and Embedder II are copyrighted and must under *NO* circumstances be
  11. distributed commercially without an agreement with the author. If the archive
  12. and files are kept exactly like listed below, the "EmbedderII.LHA" archive can
  13. be freely distributed in any non-commercial electronic form.
  14.  
  15.  
  16. The archive "EmbedderII.LHA" should contain the following files:
  17.  
  18. EmbedderII/
  19.  Docs.info      Embedder        Embedder.info   Icons.info
  20.  
  21. EmbedderII/Docs
  22.  EmbedderII.doc EmbedderII.doc.info     Arguments.doc   Arguments.doc.info
  23.  
  24. EmbedderII/Icons
  25.  Embedder.info  Embedder_project.info
  26.  
  27.  
  28.  
  29.                                  Disclaimer
  30.                                  ~~~~~~~~~~
  31.   The creator of this program can and will in no way be held responsible for
  32. any family crisis, genetic mutations or damage on computers and/or software.
  33. So if you use it, you're the only one responsible for anything caused by this
  34. piece of software.
  35. Except from this I hope you'll enjoy and use it a lot....
  36.  
  37.  
  38.  
  39.                                 Introduction
  40.                                 ~~~~~~~~~~~~
  41.   Welcome to the world of Embedder, one of the most usable process embedding
  42. utilities around. If you know programs like Degrader you may have a slight
  43. idea of what Embedder can and will do for you.
  44.  
  45.   This utility was written because intros and demos that doesn't work with
  46. caches, AA chipset, relocated vector base, etc., is fuckin' annoying to deal
  47. with if you haven't got an old A500 or A2000 nearby. Embedder was written with
  48. all these facts taken into account and I hope it will help a lot of people.
  49.  
  50.   As most users with accellerated Amigas or A1200/A3000/A4000 owners use
  51. Workbench as their desktop, Degrader isn't much fun for these users at all.
  52. Therefore I wrote Embedder. There's been another version out some time ago;
  53. Embedder V1.1 in fact. But please note that this is Embedder II V1.0 and is
  54. a totally rewritten program, as it's smaller, faster and better.
  55.  
  56.   Embedder features usage from both Workbench and a CLI/Shell with the
  57. possibility of total configurability from both platforms. So although
  58. Workbench usage is favourized by me, there's help for all CLI freaks too.
  59.  
  60.   The programs you "embed" will benefit from Embedders possibilities of
  61. controlling your CPU caches, the resolution of your View and sprites, the 
  62. relocation of the vector base register (VBR) and you'll get the extra feature
  63. of running cli-programs from the Workbench for free.
  64.  
  65.  
  66.  
  67.                                 Requirements
  68.                                 ~~~~~~~~~~~~
  69. To use Embedder you must be the lucky owner of a Kickstart(TM) 2.00+ (V36)
  70. although you will be a bit better of with 2.04+ (V37) because the V36 has some
  71. minor bugs. The sprite-resetting feature (part of the Embedder View controller)
  72. will only work on a Kickstart(TM) 3.0+ (V39), but as all versions older than
  73. V39 doesn't support different sprite-resolutions, this isn't a problem.
  74. To benefit from the AppIcon and the AppMenuItem you'll need at least Workbench
  75. V36. All functions that require a 68010 and better CPU can be used safely on
  76. 68000 too.
  77.  
  78.  
  79.  
  80.                                  Features
  81.                                  ~~~~~~~~
  82.   There are 4 basic features of Embedder that I want to explain here.
  83.  
  84.   Cache control is not the most common problem when running A500 intros on
  85. accelerated machines, but if nothing else works, you'll have to try it.
  86. Embedder have the ability of dis-/enabling both instruction and data caches on
  87. all present Motorola® CPU's (Don't know about the 060 yet! ;-) )
  88.  
  89.   The VBR is one of the most common problems with intros at present. It
  90. relocates the base address of all CPU exception vectors and thereby causes the
  91. interrupts never being executed. I guess you noticed that a lot of intros
  92. never came anywhere when first loaded or the music was probably not playing.
  93. Most trackloaded stuff hasn't got any problems with this because the vector
  94. base is first relocated when the SetPatch command is executed. On machines
  95. without fastram, the vector bae will never be relocated, so there goes another
  96. one for all you A1200 owners out there.
  97. Anyway, Embedder can set up the VBR so it seems like it isn't there at all so
  98. interrupts will work again.
  99.  
  100.   Along with the VBR, the View generated by graphics.library on AA chipset and
  101. some ECS machines is also a big problem. If you have problems with the graphics
  102. of your intros, that is if the graphics are totally module-torn-to-shit-like,
  103. then the feature of resetting the View to a totally blank display and setting
  104. the sprites back into the standard 140ns resolution of the ECS and older
  105. chipsets come in real handy.
  106.  
  107.   This is about it when dealing with Embedders embedding features.
  108. Note that all modifications to the environment will be restored, when the
  109. embedded process exits.
  110. Also note that if you disable the View, you will get a blank display from
  111. loading starts until the excuted process sets up some kind of a display.
  112.  
  113.  
  114.  
  115.                              Setting up Embedder
  116.                              ~~~~~~~~~~~~~~~~~~~
  117.   As mentioned above, Embedder runs from both CLI and Workbench. You configure
  118. Embedder via ToolTypes either way you run it. There is some differences though:
  119.  
  120.   From Workbench: Embedder will load and read it's icon to get the ToolTypes,
  121.                   then an AppIcon and an AppMenuItem is set up and you can
  122.                   start playing around.
  123.                   If the program you execute via the App's has got it's own
  124.                   icon (e.g. the Embedder_project icon) then the ToolTypes
  125.                   present here will temporarily override the startup ToolTypes.
  126.                   Note that the ToolTypes not present will NOT affect the setup
  127.                   of the specific feature.
  128.                   All programs run from the App's will run as if they were
  129.                   executed from CLI, so if you don't need the embedding
  130.                   features you can just use it to run CLI-programs from WB.
  131.                   You can also insert the path of Embedder in a project icon
  132.                   belonging to the program you want to execute, then Embedder
  133.                   will be executed every time you double-click that icon.
  134.                   When run from a project icon or when run by clicking the
  135.                   Embedder icon and the icon of the program, Embedder will
  136.                   *NOT* create App's and stay resident.
  137.                   If you use the App's a lot, you can place Embedder in the
  138.                   WBStartup directory to get that little nice icon on your
  139.                   screen immediately at LoadWb time.
  140.  
  141.   From CLI:       Here Embedder will also try to find it's icon to get the
  142.                   default setup from the ToolTypes. To specify temporary stuff,
  143.                   just enter them at the command-line.
  144.                   From the CLI the AppIcon and AppMenuItem isn't available, but
  145.                   you'll benefit from the fact, that Embedder will run without
  146.                   Workbench running.
  147.                   Embedder will throw some command-line options at you if you
  148.                   type 'Embedder ?' in the CLI and they'll look like this
  149.  
  150.                   'Cac/K,ICac/K,DCac/K,VBR/K,View/K,File/A,Args/F:'
  151.  
  152.                   and they correspond directly to the ToolTypes described below,
  153.                   except for the File/A and Args/F options which describes the
  154.                   file and arguments of the program you want to embed.
  155.  
  156.   Sample command-line: 'Embedder dcac off vbr on view on c:dir df0:s/
  157.  
  158.  
  159.  
  160.   If Embedder is unable to locate it's icon the built-in setup will be used.
  161. It goes like follows: CACHE=ON, VBR=OFF, View=OFF
  162.  
  163.   The ToolTypes understood by Embedder means what they're called :-)
  164.  
  165.         CACHE=(ON/OFF)  Determines wether you want both caches to be enabled as
  166.                         you run a process or not. Note that if you set this to
  167.                         ON and the cache is disabled it will still be turned
  168.                         on when a process is run.
  169.  
  170.         ICACHE=(ON/OFF) This en-/disables the instruction cache. It takes
  171.                         precedence over the CACHE ToolType; shares all other
  172.                         properties with CACHE.
  173.  
  174.         DCACHE=(ON/OFF) This en-/disables the data cache (including copyback).
  175.                         It takes precedence over the CACHE ToolType; shares all
  176.                         other properties with CACHE.
  177.  
  178.         VBR=(ON/OFF)    If you've got fastram you probably want to set this to
  179.                         OFF, as the chance of working interrupts is much bigger
  180.                         then. Note that the VBR is present on 68010 and higher
  181.                         only.
  182.  
  183.         VIEW=(ON/OFF)   On AA (AGA) chipsets this one should probably be off, as
  184.                         many intros/demos that put up their own copperlist will
  185.                         fail, if they don't reset the display. When View is OFF
  186.                         Embedder will remove the View and set up a blank
  187.                         old-chipset display.
  188.                         This might have an effect on ECS also when running
  189.                         SuperHires or some overscan modes.
  190.  
  191.         *NOTE* All features restores the system as it was before the embedded
  192.         process was executed.
  193.  
  194.  
  195.  
  196.  
  197.                                  Contact me!
  198.                                  ~~~~~~~~~~~
  199. You can get in touch with me in several ways...
  200.  
  201.         via InterNet:   mail me at "bigmama@bohr.ot.dk"
  202.  
  203.         via BBS:        '/Y\etal Connextion' [elite only] node 0: +45 74435949
  204.                                                           node 1: +45 74435950
  205.  
  206.         via mail:       Bigmama/Focus Design
  207.                         Jesper Matthiesen
  208.                         Skovgyden 26
  209.                         5230 Odense M
  210.                         DK-Denmark
  211.  
  212.  
  213. Contact me for almost anything but swapping. For reporting bugs, for a little
  214. coders chat or if you discovered how to code something really nice ;-)
  215.  
  216.                                                           //
  217.                                                         \X/ Amiga rulez!
  218.  
  219.  
  220.  
  221.                                    History
  222.                                    ~~~~~~~
  223. Although Embedder II hasn't got much of a history yet, I want to explain the
  224. differences between Embedder II V1.0 and Embedder V1.1.
  225. A lot of bugs should be fixed, especially the bug that left the system hangin'
  226. after the embedded process had ended. Additionally Embedder II works from CLI
  227. without Workbench running.
  228.  
  229. --------------------------------------------------------------------------------
  230. Embedder II V1.0        28-Jan-94               First release of Embedder II
  231.  
  232. Totally rewritten release of Embedder. Lots of changes...
  233. --------------------------------------------------------------------------------
  234.